Workbench Design/WB Collection.iso/workbench werkzeuge/icon tools/iconchief/doc/iconchief_english.guide

Amigaguide Document | 1996-04-07 | 14KB | 312 lines

@DATABASE IconChief.guide
@AUTHOR Stefan Schulz
@$VER: IconChief.guide 1.10 (20.09.95)
@WIDTH 75
@NODE main
@TITLE "IconChief V1.00"
                         I c o n C h i e f   V1.10

 by Stefan Schulz
                                 in  1995
                               = MAILWARE =
     Contents
     --------
     1. Get the sense
     @{" 1.1 Description       " LINK Description     }    What's this?
     @{" 1.2 Requirements      " LINK Requirements    }    All you need...
     2. How to...
     @{" 2.1 Installation      " LINK Installation    }    Unpack me...
     @{" 2.2 Usage             " LINK Usage           }    Use me...
     @{" 2.2.1 ToolTypes       " LINK ToolTypes       }    Take that!
     3. Legal Stuff
     @{" 3.1 Copyright         " LINK Copyright       }    It's mine, mine, MINE! ;o)
     @{" 3.2 Redistribution    " LINK Redistribution  }    Spread me...
     @{" 3.3 Disclaimer        " LINK Disclaimer      }    No Liability
     4. Internal Infos
     @{" 4.1 History           " LINK History         }    Once uppon a time...
     @{" 4.2 Acknowledgements  " LINK Acknowledge     }    Helping hands
     @{" 4.3 Updates           " LINK Updates         }    Where to find?
     @{" 4.4 Support           " LINK Support         }    Write, please.
@ENDNODE
@NODE Description
@TITLE "1.1 Description"
1.1 Description
    -----------
  IconChief  is  a Program which causes the Workbench to use more than just
the  usual  6  Default-Icons for Files.  If you take a look at a drawer via
Workbench  using  the Option "all Files" of the Menuitem "Show",  all Files
which  have no Icon will be displayed using one of three Default-Icons,  as
there  are  Drawer,   Program  and  Project.  The other 3 Default-icons are
reserved for Disks, Kickstart-Disks and, of course, the Trashcan.
  Especially for files of the kind Program and Project you can find out the
contents of this file by analysing or by extensions. For example if it is a
LHA-Archive  or  a  Text can easily be detected.  But even under OS 3.1 the
system doesn't pay attention to it and uses one Standard-Icon for all those
different kinds of files.
  Now comes IconChief to do what you miss.  When displaying the Files, each
of  them  will be analysed and a Default-Icon will be selected depending on
the detected kind of the file.  The workbench will get this Default-Icon as
the  "real"  Icon  owing  to  the  File.  The advantage you get is a better
optical representation of the kind of a File.  Furthermore, you can set the
Tooltypes  of  the  single Default-Icons depending on the kind.  So you can
simply  call  a  program  for  a file by double-clicking the Icon,  e.g.  a
Textviewer or a Pictureviewer, displaying Archives or playing Music.
  The analysis of the files will be done using the WhatIs.library,  written
by Sylvain Rougier and Pierre Carrette.
  Since  Version  1.10 also Disk Icons will be replaced on your wish,  if a
Default-Icon for the Disk exists.
@ENDNODE
@NODE Requirements
@TITLE "1.2 Requirements"
1.2 Requirements
    ------------
  You have to have the following to use IconChief
o  AmigaOS 2.0 (37) or higher
o  WhatIs.library Version 3 or higher
@ENDNODE
@NODE Installation
@TITLE "2.1 Installation"
2.1 Installation
    ------------
  Before  you  start IconChief the WhatIs.library has to be installed.  The
WhatIs-Package  can be found on Aminet and different PD-Series and contains
a set  of Default-Icons.  The connection between Icons and Files is written
in  FileTypes,   which is part of the WhatIs-Package,  too.  You can easily
extend this file to fit it to your own use.
  You  can  use  any  Icon  as  Default-Icon.  Just change the entry in the
FileTypes-File or set the Icon-Name to the one you want.  The Icons have to
be in the path defined by the Tooltype @{"ICONPATH" LINK ToolTypes}.
  If  the WhatIs-Package is installed,  you can test IconChief like you are
used to by starting via Workbench or Shell.  For regular use I recommend to
install  IconChief  in  the  SYS:WBStartup-Drawer,   so  it will be started
automatically with each Systemstart.
@ENDNODE
@NODE Usage
@TITLE "2.2 Usage"
2.2 Usage
    -----
  IconChief is a Commodity.  The actual version does not have any Graphical
User Interface.  For now only some @{"Tooltypes" LINK ToolTypes} are supported,  which can also
be set using the CLI.
  The  only  on  runtime  usable  function is to activate or deactivate the
funcionality of the program, i.e. the faking of the icons. You can activate
and deactivate this using the Exchange-Program (or one of the clones), like
you are used to by other commodities.
  To  save  an  Default-Icon,  so the file it was displayed for will have a
real Icon in future, simply use the item "fix" of the Workbench-Menu.
  The  program  always  tries  to  get to know if it is desired to show the
default Icons or not. In my knowledge there is only one case when IconChief
fails.   Because  the  Workbench  remembers changes of the displaymode of a
drawer, IconChief cannot get any information about this mode when a changed
drawer  is be opened again.  If this happens using the menuitem "actualize"
should help.
  To  exit  IconChief,   you can either use Exchange or start the program a
second  time.   In  both  cases it is not always safe to remove the patches
IconChief  uses  to  fake the icons for Workbench,  as other programs might
have patched the same functions. In this case a requester will be displayed
asking you,  if you want to force removing or if you want IconChief to stay
in memory.  In the second case,  the commodity-part will be removed and the
patches will be disabled.
        A FORCED DEINSTALLATION CAUSES IN MOST CASES A SYSTEMCRASH!
@ENDNODE
@NODE ToolTypes
@TITLE 2.2.1 Tooltypes
2.2.1 Tooltypes
      ---------
  The following Tooltypes are supported:
a) CX_PRIORITY:    (Default-Value: CX_PRIORITY=0)
   Sets the priority of the commodity
b) ICONPATH:       (Default-Value: ICONPATH=ENV:SYS/)
   This Tooltype defines the path where IconChief will look up the Default-
   Icons.
c) CLEANUP:       (Default-Value: CLEANUP=NEVER)
   Activating this Tooltype causes every drawer to be cleaned up after been
   opened.   The effect is like using the Workbench-Menu "Clean Up" on that
   window.
   There are five different modes you can set:
   NEVER        - Windows will never been cleaned up.
   EVERYTIME    - Each opened window will be cleaned up.
   NOICON       - Only drawers which contain no real icon,  will be cleaned
          up.
   LIST         - All  the  drawers which are mentioned in the File defined
          using  the  Tooltype  CLEANUPLIST  will  be cleaned up on
          opening.
   LISTORNOICON - Every drawer which matches one or both criteria of values
          NOICON and LIST will be cleaned up.
d) CLEANUPLIST:       (Default-Value: none)
   With this Tooltype you define the file containing a list of pathes which
   corresponding  Workbench-Drawer-Window  will  be  cleaned up on opening.
   Each   line   describes   one   Path,    which   can   also  consist  of
   AmigaDOS-Patterns.
   On Devices you have to use the logical name,  not the physical one (like
   "Ram Disk:" and not "Ram:")
   An  Example-File  named  "IconChief.CleanupList"  is  included  in  this
   package.  The line "Ram Disk:#?" for example lets IconChief clean up all
   Drawers of the Ram Disk:.
e) FAKEDISKICONS:  (Default-Value: off)
   Setting this Tooltype causes IconChief to replace default disk-icons for
   disks with icons owing to the device,  filesystem or diskname related to
   the  disk.  For a lack of the system,  disk icons on MSDOS-Disks will no
   longer be found if this mode is activated.
   Examples:
   (i)   A  file  called def_diskMSDOS in ENV:SYS/ will replace the default
     Icon for disks named MSDOS.
   (ii)  A  file  called  def_fsCrossDosFileSystem  will  place  this  icon
     instead the default CrossDosFilesystem integrated one onto the WB.
f) NODEEPSCANLIST: (Default-Value: none)
   Here  you  have to define a file containing a list of pathes,  disks and
   filesystems  which  will  not be scanned in deep but light mode.  So the
   speed is not slowed down when working on slow devices.
   An   Example-File  named  "IconChief.NoDeepScanList"  is  included.   If
   activated, all disks in DF0:  and those running under CrossDosFileSystem
   will only be scanned in light mode.
@ENDNODE
@NODE Copyright
@TITLE "3.1 Copyright"
3.1 Copyright
    ---------
  IconChief is MAILWARE, i.e.  if you use this program regulary you have to
send  me  a  message.   This  might  as well be a letter,  a postcard or an
electronic mail. If you have some remarks to the program or want to make me
a big gift you are most welcome ;o).
  You can find my @{"Address" LINK Support} at the end of this Document.
             IconChief is
 Copyright by Stefan Schulz in 1995
  For Developing this program I used the following tools
o M2Amiga Modula 2 Development-System
 Copyright 1992 by A+L AG, D
deriz 61, 2540 Grenchen
o GoldEd Release 3
 Copyright 1995 by Dietmar Eilert
o PolyEd 2.2
 Copyright 1994/95 by Avalon UnLtd. (Robert Brandner)
  Trademarks:
o Amiga, AmigaDOS and Workbench are registered trademarks of
  Commodore Amiga Inc.
@ENDNODE
@NODE Redistribution
@TITLE "3.2 Redistribution"
3.2 Redistribution
    --------------
  IconChief  may  be  redistributed  in unchanged form only.  The choice of
media is up to the Distributor. The commercial Distribution is forbidden!

  Permission  for distribution is especially granted for the Meeting Pearls
III CD-ROM
@ENDNODE
@NODE Disclaimer
@TITLE "DISCLAIMER"
3.3 DISCLAIMER
    ----------
  THERE  IS  NO  WARRANTY  FOR  THE  PROGRAM,  TO  THE  EXTENT PERMITTED BY
APPLICABLE  LAW.   EXCEPT  WHEN  OTHERWISE  STATED IN WRITING THE COPYRIGHT
HOLDER AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF
ANY  KIND,  EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
THE  ENTIRE  RISK  AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH
YOU.   SHOULD  THE  PROGRAM  PROVE  DEFECTIVE,  YOU  ASSUME THE COST OF ALL
NECESSARY SERVICING, REPAIR OR CORRECTION.
  IN  NO  EVENT  UNLESS  REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL  ANY  COPYRIGHT  HOLDER,  OR  ANY OTHER PARTY WHO MAY REDISTRIBUTE THE
PROGRAM  AS  PERMITTED  ABOVE,  BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL,  SPECIAL,  INCIDENTAL  OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE  OR  INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA  OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES  OR  A  FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN  IF  SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
@ENDNODE
@NODE History
@TITLE "History"
4.1 History
    -------
Revision 1.10 [sts] 12.07.95\\21.09.95
 +- fixed some enforcer hits
 +- added selective deep scan feature
 `- added disk.info replacement
Revision 1.00 [sts] 29.06.95\\29.06.95
 +- fixed a little bug eating memory
 `- first public release
Revision 0.53 [sts] 09.06.95\\13.06.95
 +- rewritten buggy Message-System
 +- added selective Cleanup
 `- fixed Bug which caused the system to lock up from time to time
Revision 0.52 [sts] 15.05.95\\02.06.95
 +- added sensitive Cleanup
 +- bugfix in icon-detection routine
 `- trailing slash in ICONPATH-Value is no longer a must
Revision 0.51 [sts] 08.05.95\\12.05.95
 `- added ToolType CLEANUP
Revision 0.50 [sts] 03.05.95\\03.05.95
 `- new ToolType ICONPATH for setting path to find Icons
Revision 0.42 [sts] 03.05.95\\03.05.95
 `- bugfix: tried to remove patches, even if they were not installed
Revision 0.41 [sts] 06.04.95\\06.04.95
 +- didn't clear the remembered iconlist correctly
 `- assumes type of executables now by extension
Revision 0.40 [sts] 04.04.95\\04.04.95
 `- Added handling of removing patches safely
Revision 0.31 [sts] 04.04.95\\04.04.95
 `- Changed handling of actualizating the drawer
Revision 0.30 [sts] 02.04.95\\03.04.95
 `- Commodity-Support added
Revision 0.20 [sts] 31.03.95\\01.04.95
 `- GetMsg-Patch added
Revision 0.11 [sts] 07.03.95\\14.03.95
 `- small changes and optimizations
Revision 0.10 [sts] 09.02.95\\23.02.95
 `- initial revision
@ENDNODE
@NODE Acknowledge
@TITLE "4.2 Acknowledgments"
4.2 Acknowledgements
    ----------------
  I want  to  say  thank  you  to  all the people who helped me directly or
indirectly  in  developing this program and/or supported me in technical or
mental ways.
        - Catherine
                For her love :o)))
rgen Lang
                For Beta-Testing and the idea to this Program.
    - Fionn Behrens
        For his great support in developing the program.
    - Pascal Gloor
        For Beta-Testing and the Enigma-Mailing-List-Address ;o)
        And for writing the french Documentation :o)))
    - Carsten Orthbandt
        Also for beta-testing and some very helpful advices.
    - Eric van Velthooven and Mick Hohmann
        For Beta-testing.
    - Christoph Feck
        For his help with a really nasty bug.
    - Helmuth Ritzer
        For his quick and good help.
  All those supporting Mailware. :o)
@ENDNODE
@NODE Updates
@TITLE "4.3 Updates"
4.3 Updates
    -------
  The  latest  Version of IconChief can be found on Aminet.  If a PD-Series
publishs this program (and tells me) you can also get it there. If there is
no  other  way you can also get it from me,  but of course I do not want to
spend  a  lot  of  money.   So  if  you  want it from me,  send me an empty
Floppy-Disk and the needed postage.
@ENDNODE
@NODE Support
@TITLE "4.4 Support"
4.4 Support
    -------
  Please send found errors, remarks to the program, questions or anything
else, but at least the "I use it"-Message to:
                               Stefan Schulz
                         Kurt-Schumacher-Stra
                            67663 Kaiserslautern
                                  Germany
  Or via e-mail (Internet) to:
                           [e-mail]
  You can find me on IRC too:
                                 Nick: eau
          Frequently on channels #Amiga, #TheEnd and/or #AmigaGer
@ENDNODE